<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<link href="../css/docs.css" type="text/css" rel="stylesheet" />
<link href="../css/prettify.css" type="text/css" rel="stylesheet" />
<script src="../js/prettify.js" type="text/javascript"></script>
</head>
<body onLoad="prettyPrint()">
<div class="g-unit" id="doc-content">
<div id="api-info-block">
<div class="api-level">H3C CAS云管理平台</div>
</div>
<div id="jd-header">
<h1>查询CAS系统中资源池下的vGPU资源列表</h1>
</div>
<div id="jd-content">
<div class="jd-descr">
<p>根据资源池ID查询CAS系统中资源池下的vGPU资源列表。</p>
<h2><a name="uri"></a>接口 URI</h2>
<p>/cas/casrs/resPool/queryResPoolVgpuList?resPoolId={resPoolId}&amp;offset={offset}&amp;limit={limit}</p>
<h2><a name="access"></a>访问方法</h2>
<dl>
  <dt><b>HTTP 方法</b></dt>
  <dd>GET</dd>
  <dt><b>参数</b></dt>
    <table id="pubmethods" class="jd-sumtable"><tbody><tr>
          <th colspan="2">查询参数（Query Parameter）</th>
        </tr>
	        <tr >
	          <td class="jd-typecol">resPoolId</td>
	          <td class="jd-linkcol" width="100%">
	            <span class="sympad">资源池id 。</span>
                <div class="jd-descrdiv">长整数（long）类型。必须。</div>	          </td>
	        </tr>
			<tr>
        <td class="jd-typecol">offset</td>
        <td class="jd-linkcol" width="100%"><span class="sympad">查询起始位置 。</span><div class="jd-descrdiv">整数（int）类型。 可选。</div>        </td>
      </tr>
	  <tr>
        <td class="jd-typecol">limit</td>
        <td class="jd-linkcol" width="100%"><span class="sympad">查询记录数 。 </span>
          <div class="jd-descrdiv">整数（int）类型。 可选。 </div>        </td>
      </tr>
        </table>
  </dl>
<h2><a name="result"></a>返回结果</h2>
<dl>
  <dt><b>状态码</b></dt>
  <dd>
  <ul>
    <li>200(OK)：成功。</li>
  </ul>
  </dd>
  <dt><b>消息头</b></dt>
  <div class="source"><pre class="prettyprint lang-xml">HTTP/1.1 200 OK<br>Set-Cookie: JSESSIONID=949B37D4A682C9E03AEBEE02B167E78B; Path=/cas
Total: 1<br>Content-Type: application/xml<br>Content-Length: 898<br>Date: Sat, 03 Feb 2018 08:48:43 GMT<br>Server: H3C-CVM</pre>
  </div>
  <dt><b>消息体</b></dt>
  <div class="source"><pre class="prettyprint lang-xml">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;&lt;list&gt;<br>  &lt;vgpu&gt;<br>    &lt;bus&gt;0000:05:00.0&lt;/bus&gt;
    &lt;name&gt;GRID M60-0Q&lt;/name&gt;
    &lt;type&gt;nvidia-12&lt;/type&gt;
    &lt;heads&gt;2&lt;/heads&gt;
    &lt;framebuffer&gt;512M&lt;/framebuffer&gt;
    &lt;maxResolution&gt;2560x1600&lt;/maxResolution&gt;
    &lt;maxInstance&gt;16&lt;/maxInstance&gt;
    &lt;uuid&gt;c2177883-f1bb-47f0-914d-32a22e3a8804&lt;uuid&gt;<br>    &lt;clusterId&gt;1&lt;/clusterId&gt;<br>    &lt;hostId&gt;13&lt;/hostId&gt;<br>    &lt;hostName&gt;cvk2059&lt;/hostName&gt;
    &lt;isUsed&gt;1&lt;/isUsed&gt;<br>    &lt;title&gt;win7-pt2&lt;/title&gt;<br>  &lt;/vgpu&gt;<br>&lt;/list&gt;</pre>
  </div>
</dl>
<dt><a name="detail"></a><b>元素含义</b></dt>
<table class="jd-sumtable" id="pubmethods">
  <tr>
    <th colspan="2"><span class="prettyprint lang-xml">vgpu</span>各子元素</th>
  <tr >
    <td class="jd-typecol"><span class="prettyprint lang-xml">bus</span></td>
    <td width="100%" class="jd-linkcol"><span class="sympad">GPU槽号。</span>
        <div class="jd-descrdiv">字符串（String）类型。</div></td>
  </tr>
  <tr class="alt-color">
    <td class="jd-typecol"><span class="prettyprint lang-xml">clusterId</span></td>
    <td class="jd-linkcol"><span class="sympad">资源所在的集群ID。</span>
        <div class="jd-descrdiv">长整数（long）类型。</div></td>
  </tr>
  <tr>
    <td class="jd-typecol"><span class="prettyprint lang-xml">hostId</span></td>
    <td class="jd-linkcol"><span class="sympad">资源所在的主机ID。</span>
        <div class="jd-descrdiv">长整数（long）类型。</div></td>
  </tr>
  <tr class="alt-color">
    <td class="jd-typecol"><span class="prettyprint lang-xml">hostName</span></td>
    <td class="jd-linkcol"><span class="sympad">资源所在的主机名称。</span>
        <div class="jd-descrdiv">字符串（String）类型。</div></td>
  </tr>
  <tr >
    <td class="jd-typecol"><span class="prettyprint lang-xml">type</span></td>
    <td class="jd-linkcol"><span class="sympad">vGPU的类型。</span>
        <div class="jd-descrdiv">字符串（String）类型。</div></td>
  </tr>
  <tr class="alt-color">
    <td class="jd-typecol"><span class="prettyprint lang-xml">name</span></td>
    <td class="jd-linkcol"><span class="sympad">vGPU的名称。</span>
        <div class="jd-descrdiv">字符串（String）类型。</div></td>
  </tr>
  <tr >
    <td class="jd-typecol"><span class="prettyprint lang-xml">maxInstance</span></td>
    <td class="jd-linkcol"><span class="sympad">vGPU的最大虚拟个数。</span>
        <div class="jd-descrdiv">整数（int）类型。</div></td>
  </tr>
  <tr class="alt-color">
    <td class="jd-typecol"><span class="prettyprint lang-xml">framebuffer</span></td>
    <td class="jd-linkcol"><span class="sympad">vGPU的帧缓存。</span>
        <div class="jd-descrdiv">字符串（String）类型。</div></td>
  </tr>
  <tr >
    <td class="jd-typecol"><span class="prettyprint lang-xml">maxResolution</span></td>
    <td class="jd-linkcol"><span class="sympad">vGPU的最大分辨率。</span>
        <div class="jd-descrdiv">字符串（String）类型。</div></td>
  </tr>
  <tr class="alt-color">
    <td class="jd-typecol"><span class="prettyprint lang-xml">heads</span></td>
    <td class="jd-linkcol"><span class="sympad">vGPU的显示器接口数。</span>
        <div class="jd-descrdiv">整数（int）类型。</div></td>
  </tr>
  <tr>
    <td class="jd-typecol"><span class="prettyprint lang-xml">uuid</span></td>
    <td class="jd-linkcol"><span class="sympad">vGPU的UUID唯一标识符。</span>
        <div class="jd-descrdiv">字符串（String）类型。</div></td>
  </tr>
  <tr>
    <td class="jd-typecol"><span class="prettyprint lang-xml">isUsed</span></td>
    <td class="jd-linkcol"><span class="sympad">vGPU是否被使用。</span>
        <div class="jd-descrdiv">整数（int）类型。枚举值：<span class="sympad">0 空闲 1 使用中。</span></div></td>
  </tr>
  <tr>
    <td class="jd-typecol"><span class="prettyprint lang-xml">title</span></td>
    <td class="jd-linkcol"><span class="sympad">使用此vGPU的虚拟机显示名称。若没有被使用则无。</span>
        <div class="jd-descrdiv">字符串（String）类型。</div></td>
  </tr>
  <tbody>
</table>
<p>&nbsp;</p>
<h2><a name="example"></a>应用举例</h2>
    <p>1.查询 CAS系统中资源池下vGPU资源列表。</p>
    <dl>
      <dt><b>请求</b></dt>
      <div class="source">
        <pre class="prettyprint lang-xml">GET http://localhost:8080/cas/casrs/resPool/queryResPoolVgpuList?resPoolId=15
accept: application/xml
...
        </pre>
      </div>
      <dt><b>回应</b></dt>
      <div class="source">
        <pre class="prettyprint lang-xml">HTTP/1.1 200 OK<br>Set-Cookie: JSESSIONID=949B37D4A682C9E03AEBEE02B167E78B; Path=/cas
Total: 1<br>Content-Type: application/xml<br>Content-Length: 898<br>Date: Sat, 03 Feb 2018 08:48:43 GMT<br>Server: H3C-CVM

&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;<br>&lt;list&gt;<br>  &lt;vgpu&gt;<br>    &lt;bus&gt;0000:06:00.0&lt;/bus&gt;<br>    &lt;type&gt;nvidia-11&lt;/type&gt;<br>    &lt;name&gt;GRID M60-0B&lt;/name&gt;<br>    &lt;maxInstance&gt;16&lt;/maxInstance&gt;<br>    &lt;framebuffer&gt;512M&lt;/framebuffer&gt;<br>    &lt;maxResolution&gt;2560x1600&lt;/maxResolution&gt;<br>    &lt;heads&gt;2&lt;/heads&gt;<br>    &lt;uuid&gt;05b21330-0600-56bd-a7f8-5397d44d8f14&lt;/uuid&gt;<br>    &lt;hostId&gt;13&lt;/hostId&gt;<br>    &lt;hostName&gt;cvk2059&lt;/hostName&gt;<br>    &lt;clusterId&gt;1&lt;/clusterId&gt;<br>    &lt;isUsed&gt;1&lt;/isUsed&gt;<br>    &lt;title&gt;win7-pt2&lt;/title&gt;<br>  &lt;/vgpu&gt;<br>  &lt;vgpu&gt;<br>    &lt;bus&gt;0000:06:00.0&lt;/bus&gt;<br>    &lt;type&gt;nvidia-11&lt;/type&gt;<br>    &lt;name&gt;GRID M60-0B&lt;/name&gt;<br>    &lt;maxInstance&gt;16&lt;/maxInstance&gt;<br>    &lt;framebuffer&gt;512M&lt;/framebuffer&gt;<br>    &lt;maxResolution&gt;2560x1600&lt;/maxResolution&gt;<br>    &lt;heads&gt;2&lt;/heads&gt;<br>    &lt;uuid&gt;0b893505-0600-5ae2-aa22-d25bb5a64c5a&lt;/uuid&gt;<br>    &lt;hostId&gt;13&lt;/hostId&gt;<br>    &lt;hostName&gt;cvk2059&lt;/hostName&gt;<br>    &lt;clusterId&gt;1&lt;/clusterId&gt;<br>    &lt;isUsed&gt;0&lt;/isUsed&gt;<br>  &lt;/vgpu&gt;<br>  &lt;vgpu&gt;<br>    &lt;bus&gt;0000:06:00.0&lt;/bus&gt;<br>    &lt;type&gt;nvidia-11&lt;/type&gt;<br>    &lt;name&gt;GRID M60-0B&lt;/name&gt;<br>    &lt;maxInstance&gt;16&lt;/maxInstance&gt;<br>    &lt;framebuffer&gt;512M&lt;/framebuffer&gt;<br>    &lt;maxResolution&gt;2560x1600&lt;/maxResolution&gt;<br>    &lt;heads&gt;2&lt;/heads&gt;<br>    &lt;uuid&gt;232969fc-0600-50c1-a7fa-3b80066472ed&lt;/uuid&gt;<br>    &lt;hostId&gt;13&lt;/hostId&gt;<br>    &lt;hostName&gt;cvk2059&lt;/hostName&gt;<br>    &lt;clusterId&gt;1&lt;/clusterId&gt;<br>    &lt;isUsed&gt;0&lt;/isUsed&gt;<br>  &lt;/vgpu&gt;<br>&lt;/list&gt;</pre>
      </div>
    </dl>
    </div>
</div>
</div>
</body>
</html>